﻿/*******************************************************************************************
 * Copyright (c) 2006-2009 Alex Robson, Rob Simmons, Craig Israel, and Rachel Twyford
 *
 * Use of this software in any form requires that you have both 
 * read and agreed to the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions: 
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the 
 * documentation and/or other materials provided with the distribution.
 * Neither the name of Nvigorate nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ****************************************************************************************/

using System;
using System.Collections.Generic;
using Nvigorate.Relational.Mapping.Interface;

namespace Nvigorate.Relational.Record
{
    /// <summary>
    /// An abstract collection of fields and their values
    /// </summary>
    public interface IRecord : IDisposable
    {
        /// <summary>
        /// Number of fields in this record 
        /// </summary>
        int FieldCount { get; }

        /// <summary>
        /// Returns the value for the field
        /// </summary>
        /// <param name="fieldName">Name of the desired field value</param>
        /// <returns>Object</returns>
        object this[string fieldName]
        {
            get; set;
        }

        /// <summary>
        /// Returns the value for the field
        /// </summary>
        /// <param name="fieldIndex">Name of the desired field value</param>
        /// <returns>Object</returns>
        object this[int fieldIndex]
        {
            get; set;
        }

        /// <summary>
        /// Returns the value for the field
        /// </summary>
        /// <param name="point">The assignment point which describes how to get the value from the record</param>
        /// <returns>object</returns>
        object this[IAssignmentPoint point]
        {
            get; set;
        }

        /// <summary>
        /// List of field names in this record
        /// </summary>
        List<string> FieldNames { get; }

        /// <summary>
        /// Array of field values in this record
        /// </summary>
        object[] FieldValues { get; }

        /// <summary>
        /// The name of the source for this record
        /// </summary>
        string RecordSource { get; }

        /// <summary>
        /// Returns the list of sources which contributed data.
        /// This is crucial to the update code.
        /// </summary>
        /// <param name="map"></param>
        /// <returns></returns>
        List<string> GetContributingSources(IBindingMap map);

        /// <summary>
        /// Returns the type of the given field name
        /// </summary>
        /// <param name="fieldName">Field name</param>
        /// <returns>Type</returns>
        Type GetFieldType(string fieldName);

        /// <summary>
        /// Returns the type of the field at the given index
        /// </summary>
        /// <param name="fieldIndex"></param>
        /// <returns></returns>
        Type GetFieldType(int fieldIndex);

        /// <summary>
        /// Returns all related records by relationship name
        /// </summary>
        /// <returns></returns>
        List<IRecord> GetRelatedRecords(string relationship);

        /// <summary>
        /// Returns an empty record which represents the schema
        /// of the related record
        /// </summary>
        /// <param name="relationship"></param>
        /// <returns></returns>
        IRecord GetRelatedSchemaRecord(string relationship);

        /// <summary>
        /// Determines whether or not this record contains a value given
        /// an assignment point.
        /// </summary>
        /// <param name="point"></param>
        /// <returns></returns>
        bool HasFieldForAssignment(IAssignmentPoint point);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="point"></param>
        /// <returns></returns>
        object GetValueForAssignment(IAssignmentPoint point);
    }
}